home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 008 / grafpak1.arc / GRAFPAK.DOC next >
Encoding:
Text File  |  1985-11-22  |  6.7 KB  |  152 lines

  1.                             G R A F P A K
  2.  
  3.                             Documentation
  4.                             
  5.  
  6.     Grafpak requires a Color/Graphics card and at least 192K of 
  7.     RAM to operate.  It does not require the use of an 8087 but 
  8.     I have a version of Grafpak that does and it is much faster 
  9.     than w/out.
  10.     
  11.     
  12.     Grafpak is a X,Y data , analysis and graphing program. The
  13.     user may input pairs of X,Y data, store and retrieve them as
  14.     well as plot them , either in raw form or fitted with 2 types
  15.     of curves. Either Interpolation or a Polynomial is used The
  16.     data may be fitted with an interpolation scheme that makes any
  17.     data smooth. The method is called spliced cubic interpolation
  18.     for those interested. The alternative approach is to fit the
  19.     data with an Nth order Polynomial in the form of Y = NN * X^NN
  20.     + ... N1 * X + N0. This method is a form of smoothing and
  21.     extrapolation good for forecasting and trend analysis. Both
  22.     methods have thier merit.
  23.     
  24.       Grafpak is Menu and Command line driven. The appropriate 
  25.     Function key or first letter of a command is all that is 
  26.     necessay. Carriage returns are only necessary for numeric 
  27.     input and file names.
  28.     
  29.     
  30.                                Level #1
  31.     
  32.       The first level is the data input or utility level. This is
  33.     where you tell the program how to get it's data. You may
  34.     either Enter new data , Retrieve a disk file , Read a disk
  35.     directory or Quit.
  36.       
  37.       Entering new X,Y pairs takes you to a new menu where you can
  38.     input new pairs or enter user coefficients. Coefficients are a
  39.     rather advanced subject, and apply to coefficients for a
  40.     polynomial of the Nth order. The same coefficients are 
  41.     disaplayed after fitting data with a polynomial. Unless you 
  42.     know what you're doing you should let this feature alone. 
  43.     Upon entering new pairs you will be taken to the next level 
  44.     down where you may operate on your data.
  45.     
  46.       Retrieving a disk file is also straight forward. The file 
  47.     must , of course , already exist. The files are created in 
  48.     two ways. You may use the "Enter new data option" and enter 
  49.     your pairs, after entry you will be prompted to save these 
  50.     pairs in a file , you should do so. If you have an editor or 
  51.     are patient with the DOS `copy con: filename' you can enter 
  52.     data into your own file and then use Retrieve to read your 
  53.     data. The file format I use is straight ASCII with the 
  54.     first line being the integer number of pairs to follow and 
  55.     the next N lines being pairs of data , either integer or FP 
  56.     , with a space seperating the pairs (eg  1.0  2.45). After 
  57.     sucessfully reading in a file you will be taken to level 2, 
  58.     where you can operate on your data.
  59.     
  60.     
  61.     
  62.                                Level #2
  63.  
  64.       Level 2 will be your main operating level. At this point 
  65.     you have data in memory. Grafpak is based on two arrays, 
  66.     where array #1 holds the user's data and array #2 will hold 
  67.     some representation of the data in array #1 or a second 
  68.     file inported into memory and stored in array #2. So at this 
  69.     level you may either `Read a second file into memory' , 
  70.     `Display the data or Edit the data' , `Plot the Data' , 
  71.     `Interpolate the data' , `Polynomial fit to the data' or 
  72.     return to level #1.
  73.     
  74.       Reading a second file into memory does as it implies, the 
  75.     new data is put into array #2 and the user is returned the 
  76.     the level #2 menu again. (See above).
  77.     
  78.       Displaying or Editing the data allows the user to see what 
  79.     he has just entered and allows him to Edit it if desirable. 
  80.     The user is also given a chance to re-file the edited data 
  81.     if edited.
  82.     
  83.       Plotting the data is the whole idea of this program. This 
  84.     will call the plotting module. This will line graph the 
  85.     user's data in array #1 (also array #2 if a second file has 
  86.     been read in). There will be no interpolation or fitting at 
  87.     this point just a display of the raw data. Once the plot is 
  88.     displayed on the screen the user has a command line of 
  89.     choices , Quitting the plotting module will bring the user 
  90.     back to the level #2 menu again.
  91.     
  92.     
  93.       Interpolating the data in array #1 will result in an 
  94.     interpolation of array #1 in array #2. The user will be 
  95.     asked how many intervals he desires between actual data 
  96.     points. Generally the larger the number of intervals the 
  97.     smoother the data will appear. An interval of 1 does 
  98.     absolutely nothing except repeat the data in array #1. Once 
  99.     you choose your interpolation the user will see a command 
  100.     line of options on the very bottom line of the CRT. this is 
  101.     a single key command line that will either file the 
  102.     resultant interpolation , interpolate any Y for you , or 
  103.     Plot the data vs interpolation.
  104.     
  105.     
  106.       Fitting the data will call a least squares polynomial 
  107.     evaluation module, and will place the resultant X,Y pairs into
  108.     array #2. The user will be asked for the Order of the
  109.     polynomial (Up to 15th order). The order of a polynomial means
  110.     the highest power of X that a coefficient is generated for. An
  111.     order of 1 means a straight line is passed through the user's
  112.     data, representing an expression like Y = X^1 * C , where C is
  113.     a unique coiefficient and X is between some predefined range.
  114.     Generally speaking the bumpier your data is the higher the
  115.     order of a polynomial will be required to best fit the data.
  116.     Polynomial evaluation is a science in itself and can be used
  117.     for several applications. Once the user enters the order of
  118.     the fit to be done, the program performs the fit and lists the
  119.     coefficients and thier powers of X as well as a percentage of
  120.     fit. Once the fit is performed the user is provided a command
  121.     line of options, on the last line of the CRT. The options
  122.     available are Expanding the fit to give you more pairs of data
  123.     within the same range of X's using the polynomial expression
  124.     just calculated. Filing the new data in array #2 to disk. 
  125.     Reviewing the fit vs the data, where the X , Y , Ycalculated 
  126.     , and the Delta are dispalyed for all the user's pairs of 
  127.     data. DeltaPlot will plot the difference of the user's data 
  128.     and the resultant fit. Plot will plot the user's data vs 
  129.     whatever is in array #2 , either expanded fit or fit. The 
  130.     user also has the option of quitting to either the top most 
  131.     level or the level just above.
  132.     
  133.     
  134.     
  135.     
  136.     
  137.     I realize that this is slim documentation , but like most 
  138.     programmers that comes last, and I'm constantly changing 
  139.     Grafpak so this will have to suffice for now.
  140.     I would appreciate any comments or suggestions that you have 
  141.     regarding Grafpak. I can be reached at...
  142.       
  143.       Peter Worcester
  144.       
  145.       c/o
  146.          Pconn RBBS
  147.          PCSI  RBBS
  148.          HACKERS RBBS
  149.       
  150.      Thanks , and I hope you find this program useful.
  151.      
  152.